home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / latex209 / contrib / aasmacros / README < prev    next >
Text File  |  1993-02-14  |  14KB  |  329 lines
  1. % README -- Contents of the AASTeX macro package distribution
  2.  
  3. Thanks for your interest in the AASTeX macros for manuscript preparation.
  4. This directory contains all the files in the distribution.  They are
  5. described briefly immediately below.  Following the file descriptions
  6. are short installation instructions, the generic recipe for printing the
  7. user guide and samples, and information about contacting us regarding
  8. the distribution.
  9.  
  10.  
  11. README            This file
  12.  
  13. aasms.doc        Fully documented source for the "manuscript"
  14.             substyle.  Contains macro definitions + comments.
  15. aasms.sty        LaTeX input style file for the "manuscript"
  16.             substyle.  This is the .doc file stripped of
  17.             comments and unnecessary whitespace.
  18.  
  19. aaspp.doc        Fully documented source for the "preprint"
  20.             substyle.  Contains macro definitions + comments.
  21. aaspp.sty        LaTeX input style file for the "preprint"
  22.             substyle.  This is the .doc file stripped of
  23.             comments and unnecessary whitespace.
  24.  
  25. aaspptwo.doc        Documented source for a two-column preprint substyle.
  26. aaspptwo.sty        LaTeX input style file for two-column preprint
  27.             substyle.
  28.  
  29. aj_pt.doc        Documented source for the AJ plano tables substyle.
  30. aj_pt.sty        LaTeX input style file for AJ plano tables substyle.
  31.  
  32. apjpt.doc        Documented source for the ApJ plano tables substyle.
  33. apjpt.sty        LaTeX input style file for ApJ plano tables substyle.
  34.  
  35. art8.doc        Documented 8pt style option.
  36. art8.sty        LaTeX input style file for the 8pt style option.
  37.  
  38. eqsecnum.sty        Substyle file that enables equations to be
  39.             numbered with sections, rather than ordinally.
  40. tighten.sty        Substyle file that causes "manuscript" style
  41.             papers to be single-spaced rather than double.
  42.  
  43. epsf.sty        A copy of Rokicki's epsf.sty file that is supplied
  44.             with dvips.  It is included so that style files
  45.             can be interpreted, and so that authors can
  46.             include proper space for EPS files even if they
  47.             do not have dvips.
  48.  
  49. aastex.tex        The user input guide for the package.
  50.  
  51. sample1.tex        Minimal sample paper.
  52. sample2.tex        Sample paper with "typical" content and markup.
  53. samp2tbl.tex          "Long" table for sample, marked up as a plano
  54.               table in the manuscript.
  55.  
  56. samptbls.tex        Plano tables sample.  Sets style and includes:
  57. table1.tex          Sample plano table #1.
  58. table2.tex          Sample plano table #2.
  59. table3.tex          Sample plano table #3.
  60.  
  61. graphics.tex        Initial proposal to WGAS and Pubs Board
  62.             suggesting standardized use of Encapsulated
  63.             PostScript for graphics inclusions.
  64. sgi*.eps        Encapsulated PostScript plots for graphics.tex.
  65.  
  66. kspp.tex        Preprint format proposal from K.Sellgren to the
  67.             Pubs Board.
  68.  
  69. paper1.tex        LaTeX source for June 1989 AAS poster.
  70. paper2.tex        LaTeX source for June 1990 AAS poster.
  71.  
  72.  
  73. aastex30.tar.Z        All of the above files can be retrieved at once
  74.             in this compressed tarfile, if desired.
  75.  
  76.  
  77. INSTALLING THE STYLE FILES
  78.  
  79. The *.sty files must be "installed" so that LaTeX can read them.  This
  80. simply means that they must be placed either in (1) the user's working
  81. directory containing the paper being processed [single-user installation],
  82. or (2) in the TeX/LaTeX system input directory [site-wide installation].
  83.  
  84. Individuals who obtain the files for their personal use should just put
  85. the files in the same directory that they usually use when preparing
  86. papers, memos, etc. with LaTeX.
  87.  
  88. Sites that expect usage by several authors will probably find it preferable
  89. to install the files in the standard TeX inputs area.  In the parlances of
  90. popular OS's, these areas are typically called
  91.  
  92.     /usr/local/lib/tex/inputs    Unix and variants
  93.     SOME$DISK:[TEX.INPUTS]        VMS/Files-11 specification
  94.     C:\EMTEX\TEXINPUT        DOS
  95.  
  96. The *.doc files are not actually read by LaTeX.  They are the "source code"
  97. files for the corresponding .sty files.  The *.sty files are produced
  98. mechanically from the *.doc files; these .sty files are never edited.
  99. Most installations of LaTeX keep .doc and .sty files in the same directory
  100. so that they can be easily found.  We suggest doing the same with these.
  101.  
  102. The user's guide and sample papers could be kept in a system-wide TeX
  103. inputs directory as well, but the system administrator may find it desirable
  104. to change the filenames somewhat, since they are quite generic and prone
  105. to filename collisions.
  106.  
  107.  
  108. PRINTING THE GUIDE AND SAMPLES
  109.  
  110. The User Guide should be printed out for best results in reading it.
  111. The Guide is written using the aaspp substyle from the AASTeX macro
  112. package, and is therefore a LaTeX document.  It must be processed by
  113. LaTeX, resulting in a compiled, device-independent format (a .dvi file).
  114. The DVI file has to be translated through a program that knows about the
  115. specific printer you wish to print on; such a program is often called a
  116. "DVI driver".
  117.  
  118. Suppose you wish to print on a PostScript laser printer, and that the
  119. DVI driver on your computer system is called "dvips".  The generic steps
  120. to be followed to get hardcopy are
  121.  
  122.     prompt> latex aastex
  123.     prompt> dvips aastex
  124.     prompt> print aastex.ps
  125.  
  126. There are various system- and program-specific eccentricities which
  127. cannot be fully enumerated here.  Some things to watch out for:
  128.  
  129.     1.  On some systems, TeX and LaTeX do not permit a filename extension
  130.     (the .tex) on the input file specification; .tex is assumed.
  131.     On other systems, it is optional.
  132.     2.  Most DVI drivers do not require the .dvi extension on the input
  133.     filename.  The extension of the output file (the one destined
  134.     for a specific printer) is variable, often a site-dependent
  135.     configuration parameter.
  136.     3.  The user interfaces for DVI drivers are quite inconsistent.
  137.     Some operate in an interactive mode, asking the user about
  138.     variable setup parameters, while some only accept control
  139.     input on the command line.
  140.     4.  On some systems, the DVI translation and printing are combined,
  141.     so one would enter only one OS command after running LaTeX.
  142.  
  143. There is no way for us to know details of your installation, so you must
  144. inquire of the system administrator responsible for LaTeX, or hope that
  145. someone has written the LaTeX "Local Guide" for your site.
  146.  
  147.  
  148. ADMINISTRATIVE DETAILS
  149.  
  150. This package has been prepared by Chris Biemesderfer on behalf of the
  151. AAS Executive Office.  It has evolved from a project of the Working
  152. Group on Astronomical Software (WGAS), chaired by Bob Hanisch of the
  153. Space Telescope Science Institute in Baltimore.  We would like to
  154. express appreciation to the National Radio Astronomy Observatory and
  155. National Optical Astronomy Observatories for their support of this
  156. project during its germination.
  157.  
  158. Comments, suggestions, complaints, etc., can be sent electronically.
  159. Community feedback is valuable, and will be retained and evaluated so
  160. that we can coordinate the evolution of the package with the
  161. requirements of editors and publishers as moderated by the AAS
  162. Executive Office and the Publications Board.
  163.  
  164. cbiemes@noao.edu
  165. 7 Jan 1993
  166.  
  167.  
  168. REVISION HISTORY
  169.  
  170. v1.0, Feb 1989
  171.     Original test version written at STScI and NRAO.
  172.  
  173. v2.0, Jun 1990
  174.     First public release of package to community following AAS meeting
  175.     in Albuquerque.
  176.  
  177. v2.1, May 1991
  178.     Changed style filenames: aasmanuscript -> aasms, aaspreprint -> aaspp
  179.     for benefit of DOS users, and to conform to Posix.
  180.  
  181.     Fixed the textheight to compensate for header and footer space
  182.     so that page numbers will in fact be on the bottoms of the pages.
  183.  
  184.     Updated journal abbreviations as per scheme agreed upon by various
  185.     editors and announced by Helmut Abt in ApJ 357, 1.
  186.  
  187.     Added an assortment of symbols, etc. from Francois Schweizer.
  188.  
  189. v2.2, Aug 1991
  190.     Rewrote the tablenote code, using ideas from a style file posted
  191.     to the Usenet in June.  This new implementation permits the use
  192.     of any identifying letters (or number for that matter) for the
  193.     notes, and will print them in the order specified by the user
  194.     rather than assuming alphabetical.  In the process, fixed a bug
  195.     where the buffered tablenotes were not being erased from table
  196.     to table.
  197.  
  198.     Revised the way journal abbreviations are typeset.  Rather than
  199.     simply being a string, they are now processed through a macro and
  200.     the journal type style is parameterized.
  201.  
  202.     Moved the WGAS ID footnote to the last page of references from
  203.     title page.  There have been some "complaints" about this being
  204.     present at all, but it is the only way we can keep track of the
  205.     use of the package at this point, so we retain it.
  206.  
  207. v2.3, Aug 1992
  208.     Formalized naming convention for style files (see Stynames.spc).
  209.  
  210.     Revisions for compliance with RevTeX markup.
  211.     Added some revtex@ parameters for software development and
  212.     tracking/reporting purposes.  Changed mathsec substyle option
  213.     to eqsecnum (mathsec.sty -> eqsecnum.sty).  Changed
  214.     \mathwithsecnums -> \eqsecnum.  Changed \la -> \alt,
  215.     \ga -> \agt.  Added \text for cased fractions.
  216.  
  217.     Revised aasms to conform with preferences of UofC Press manuscript
  218.     editors.  Such things as ragged right text, no hyphenation, proper
  219.     double spacing in tables, etc. are ensured.  (G.Brady)
  220.  
  221.     Fixed bug that resulted in the persistent \footnoterule in table
  222.     footnotes.  (C.Pilachowski, P.Shopbell)
  223.  
  224.     Added a Makefile to ease development.
  225.  
  226. v3.0, Dec 1992
  227.     Moved page numbers to top of pages, per request from ApJ
  228.     editorial office.  Created "plaintop" pagestyle for MSs that
  229.     numbers pages at the top of the sheet, centered.
  230.  
  231.     Added \tablerefs, \tablecomments, \cutinhead, and \sidehead,
  232.     macros to facilitate handling complexities in ApJ/AJ tables.
  233.  
  234.     Added plano tables styles (non-trivial!).  This includes some
  235.     new author markup that is applicable to "long" tables in MSs
  236.     as well.  Added a "planotables" environment, and commands
  237.     for identifying structural parts of the table: \tablewidth,
  238.     \tablecaption, \tablehead, \colhead, \tableheadfrac, \tabletail,
  239.     \startdata, \nodata, \nl, \tablevspace, \tablebreak, and, in
  240.     the plano style files, \ptlandscape.
  241.  
  242.     Fixed bug with preliminary plano tables that prevented \nodata
  243.     symbol to be justified with numerals (usually r).  The ellipsis
  244.     or em-dash (or whatever) now centers horizontally as well as
  245.     vertically.  (C.Pilachowski, G.Brady)
  246.  
  247.     Added some internal parameterization and control of automatic
  248.     upper-casing of section heads, etc.  Authors should NOT be
  249.     instructed to upper case anything; the style should do this
  250.     when necessary.  See remarks in .doc file for more information
  251.     about how the style designer can control this "easily".
  252.  
  253.     Footnotes in MSs are same size as body text.
  254.  
  255.     Fixed bug in \altaffiltext so that increment LaTeX footnote now
  256.     increments with alternate affiliation footnotes.  The first
  257.     footnote called out in the text will then be properly numbered
  258.     N+1, where N is the number of \altaffiltexts.
  259.  
  260.     Added markup for ionization state: \ion.
  261.  
  262.     Added \singlespace, \doublespace so that leading can be
  263.     adjusted by authors.  Use of these is not encouraged.
  264.  
  265.     Changed \keywords syntax.  Authors are now required to provide
  266.     proper punctuation in the keyword list.  The earlier attempt at
  267.     parsing the keywords was problematic.
  268.  
  269.     Added EPS inclusion macros.  These are designed to work with
  270.     Rokicki's dvips program.  There is some concern that these
  271.     should have been designed to work with psfig instead.  My
  272.     opinion about that is that intermediate layer (psfig) is
  273.     redundant with this package and by relying on it we require
  274.     authors to have two additional add-on packages (dvips and
  275.     psfig) rather than one.  The psfig package and the EPS part
  276.     of the AASTeX package both serve the same purpose, namely,
  277.     to isolate the author from the details of the DVI driver.
  278.     The AASTeX package goes a bit farther in explicilty defining
  279.     descriptive markup semantics for specifying external plot files.
  280.  
  281.     Revisions for compliance with RevTeX markup.
  282.     Changed \tightenlines -> \tighten.  Changed \alt -> \lesssim,
  283.     \agt -> \gtrsim.  Changed \text -> \case.  Added \slantfrac.
  284.     Changed \applopt -> \ao.
  285.  
  286.     Added slug line markup for assorted administrative details.
  287.     \revised, \paperid, \ccc, \cpright, \rectohead, \versohead, and
  288.     \slugcomment can all be used in preamble.  Formatting for slug
  289.     line data has been isolated in internal \@dates, \@runheads,
  290.     \@slug, and \@makeslugcmmnt.  \@journalname and \cpr@holder
  291.     have been added as internal parameters.
  292.  
  293.     Added \authoraddr front matter (or back matter, whatever)
  294.     command for specifying author's postal address.  This is the
  295.     address that is preferred for correspondence.
  296.  
  297.     Added \markcite to correspond with references environment
  298.     to provide non-BibTeX-based citation and reference list
  299.     markup.  \markcite does not do anything typographically in
  300.     AAS styles because the citation call-out style is straight
  301.     text.  This is included partly for symmetry, but mostly
  302.     because we want to start training authors to identify
  303.     structure in their manuscripts.  In the future, browsers
  304.     with hypertext-like capabilities will be widely available
  305.     to build linkage between citations, references, and the
  306.     articles being cited/referenced, and this will facilitate
  307.     preparation of the articles for such systems.
  308.  
  309.     Changed \appendix to reset the equation counter and to
  310.     redefine \theequation.
  311.  
  312.     Added mathletters environment to support "subequations".
  313.     This environment is used to suspend incrementing of the
  314.     primary equation counter in favor of a secondary one, so
  315.     that related equations can be grouped with the same
  316.     identifying number while still being separately identified
  317.     with lower case letters.  I originally called this new
  318.     environment "letteredsubeqn" but changed to "mathletters"
  319.     for RevTeX compliance.
  320.  
  321.     Added \eqnum, \tablenum, and \figurenum commands to enable
  322.     authors to override LaTeX automatic numbering for equations,
  323.     tables and figures.  The corresponding LaTeX counter is NOT
  324.     auto-incremented when these commands are used.  The commands
  325.     function by temporarily overriding \the<counter>; formatting
  326.     defined by \@eqnnum, \fnum@table, and \fnum@figure  is not
  327.     affected.  Note that these commands must be used *inside* the
  328.     appropriate displayed equation or float environment.
  329.